<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>GcDiagnostics_ (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>

  <script type="text/javascript" src="//www.google.com/jsapi"></script>
  <script type="text/javascript">
     google.load("visualization", "1", {packages:["orgchart"]});
     var _loadingVisualizations = true;
  </script>

  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
        <span class="fn">debug.GcDiagnostics_</span>
        <span>Extends</span>
        <span class="fn-name">
          
        </span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Class used for singleton goog.debug.GcDiagnostics.  Used to hook into
the L2 ActiveX controller to profile garbage collection information in IE.
Can be used in combination with tracers (goog.debug.Trace), to provide object
allocation counts from within the tracers or used alone by invoking start and
stop.

See <a href="http://go/l2binary">http://go/l2binary</a> for the install.
TODO(user): Move the L2 installer somewhere more general.

  </div>


        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="local_closure_goog_debug_gcdiagnostics.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/local/closure/goog/debug/gcdiagnostics.js">Git</a></li>
          </ol>
        </div>
</div>






<h2 class="g-first">Inheritance</h2>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
  <tr><td>goog.debug.GcDiagnostics_</td><td></td></tr>
</table>
</div>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
</table>
</div>




  <h2>Constructor</h2>
      <div class="fn-constructor">
    goog.debug.GcDiagnostics_(<span></span>)
  </div>



<h2>Instance Methods</h2>


  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_debug_GcDiagnostics_.html">
              goog.debug.GcDiagnostics_
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.debug.GcDiagnostics_.prototype.install"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">install<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Install the GcDiagnostics tool.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_debug_gcdiagnostics.js.source.html#line46">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.debug.GcDiagnostics_.prototype.start"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">start<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Starts recording garbage collection information.  If a trace is already in
progress, it is ended.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_debug_gcdiagnostics.js.source.html#line89">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.debug.GcDiagnostics_.prototype.stop"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">stop<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Stops recording garbage collection information.  Logs details on the garbage
collections that occurred between start and stop.  If tracers are in use,
adds comments where each GC occurs.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_debug_gcdiagnostics.js.source.html#line104">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Instance Properties</h2>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_debug_GcDiagnostics_.html">
              goog.debug.GcDiagnostics_
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.debug.GcDiagnostics_.prototype.logger_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">logger_</span>
        : <span class="type"><a href="class_goog_debug_Logger.html">goog.debug.Logger</a></span>
     </div>


     <div class="entryOverview">
       Logger for the gcDiagnotics

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_debug_gcdiagnostics.js.source.html#line81">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>










<div class="section">
  <table class="horiz-rule">


  </table>
</div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package debug</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="" current="debug.GcDiagnostics_"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
